The Shireburn Business Suite (SBS) API enables you to interact with SBS systems. You will need an API key which should be passed as a query string with each of the requests below.

GET api/SIMS/GetDepartments?departmentCodes[0]={departmentCodes[0]}&departmentCodes[1]={departmentCodes[1]}&companyKey={companyKey}

Gets all the department details

Request Information

URI Parameters

Name	Description	Type	Additional information
departmentCodes	A list of category codes (Optional)	Collection of string	Required
companyKey	The company name if the service is connected to multiple SIMS companies (Optional)	string	Default value is

Body Parameters

N/A

Response Information

Resource Description

The departments

Collection of ApiDepartment

Name	Description	Type	Additional information
DepCode	The department code	string	N/A
DepDesc	The description of the department	string	N/A
OnHold	Boolean on whether the department is on hold or not	boolean	N/A
DepMu1		decimal number	N/A
DepMu2		decimal number	N/A
DepMu3		decimal number	N/A
DepMu4		decimal number	N/A
DepMu5		decimal number	N/A
DepMu6		decimal number	N/A
SpsmtCode	The code for SPSMT	string	N/A
PackTrg	The pack target	decimal number	N/A
PackTrg2	The pack target 2	decimal number	N/A
LocCode	The location code of the department (if any)	string	N/A
GrpCode	The group code of the department (if any)	string	N/A
ExportSls	Boolean check on whether sales should be exported or not	boolean	N/A
CancelWks	The number of weeks that can surpass for cancellations to be allowed	decimal number	N/A
ExpiryDays	The number of days for expiry	decimal number	N/A
ReplicId	The ReplicId of the department record	string	N/A
BtfDefaQty		decimal number	N/A
BsnsUnit		string	N/A

Response Formats

application/json, text/json

Sample:

[
  {
    "DepCode": "sample string 1",
    "DepDesc": "sample string 2",
    "OnHold": true,
    "DepMu1": 4.0,
    "DepMu2": 5.0,
    "DepMu3": 6.0,
    "DepMu4": 7.0,
    "DepMu5": 8.0,
    "DepMu6": 9.0,
    "SpsmtCode": "sample string 10",
    "PackTrg": 11.0,
    "PackTrg2": 12.0,
    "LocCode": "sample string 13",
    "GrpCode": "sample string 14",
    "ExportSls": true,
    "CancelWks": 16.0,
    "ExpiryDays": 17.0,
    "ReplicId": "sample string 18",
    "BtfDefaQty": 19.0,
    "BsnsUnit": "sample string 20"
  },
  {
    "DepCode": "sample string 1",
    "DepDesc": "sample string 2",
    "OnHold": true,
    "DepMu1": 4.0,
    "DepMu2": 5.0,
    "DepMu3": 6.0,
    "DepMu4": 7.0,
    "DepMu5": 8.0,
    "DepMu6": 9.0,
    "SpsmtCode": "sample string 10",
    "PackTrg": 11.0,
    "PackTrg2": 12.0,
    "LocCode": "sample string 13",
    "GrpCode": "sample string 14",
    "ExportSls": true,
    "CancelWks": 16.0,
    "ExpiryDays": 17.0,
    "ReplicId": "sample string 18",
    "BtfDefaQty": 19.0,
    "BsnsUnit": "sample string 20"
  }
]